Package com.netscape.certsrv.client

Class PKIClient

java.lang.Object

com.netscape.certsrv.client.PKIClient

All Implemented Interfaces:

AutoCloseable

public class PKIClient
extends Object
implements AutoCloseable

Field Summary

Fields

Modifier and Type	Field	Description
String	apiVersion
URI	basicURI
ClientConfig	config
PKIConnection	connection
Info	info
InfoClient	infoClient
static org.slf4j.Logger	logger
static final String[]	MESSAGE_FORMATS

Constructor Summary

Constructors

Constructor	Description
PKIClient(ClientConfig config)
PKIClient(ClientConfig config, String apiVersion, org.mozilla.jss.ssl.SSLCertificateApprovalCallback callback)
PKIClient(ClientConfig config, org.mozilla.jss.ssl.SSLCertificateApprovalCallback callback)

Method Summary

Modifier and Type	Method	Description
void	close()
<T> T	delete(String path, Class<T> responseType)
<T> T	delete(String path, Map<String,Object> params, Class<T> responseType)
<T> org.apache.http.HttpEntity	entity(T object)
<T> T	get(String path, Class<T> responseType)
<T> T	get(String path, Map<String,Object> params, Class<T> responseType)
String	getAPIVersion()
<T> Collection<T>	getCollection(String path, Map<String,Object> params, Class<T> responseType)
ClientConfig	getConfig()
PKIConnection	getConnection()
String	getDefaultMimeType()
<T> Collection<T>	getEntities(org.apache.http.client.methods.CloseableHttpResponse httpResp, Class<T> clazz)
<T> T	getEntity(org.apache.http.client.methods.CloseableHttpResponse httpResp, Class<T> clazz)
Info	getInfo()
String	getSubsystem()
void	handleErrorResponse(org.apache.http.client.methods.CloseableHttpResponse httpResp)
String	marshall(Object request)	Marshall request object with custom mapping if available.
<T> T	patch(String path, Map<String,Object> params, org.apache.http.HttpEntity entity, Class<T> responseType)
<T> T	post(String path, Class<T> responseType)
<T> T	post(String path, List<org.apache.http.NameValuePair> content, Class<T> responseType)
<T> T	post(String path, Map<String,Object> params, Class<T> responseType)
<T> T	post(String path, Map<String,Object> params, org.apache.http.HttpEntity entity, Class<T> responseType)
<T> T	put(String path, Map<String,Object> params, org.apache.http.HttpEntity entity, Class<T> responseType)
void	setOutput(File output)
org.apache.http.client.utils.URIBuilder	target(String path, Map<String,Object> params)
<T> T	unmarshall(org.apache.http.HttpEntity entity, Class<T> clazz)	Unmarshall response object using custom mapping if available.
<T> Collection<T>	unmarshallCollection(org.apache.http.HttpEntity entity, Class<T> clazz)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

public static org.slf4j.Logger logger

MESSAGE_FORMATS

public static final String[] MESSAGE_FORMATS

config

public ClientConfig config

connection

public PKIConnection connection

apiVersion

public String apiVersion

infoClient

public InfoClient infoClient

info

public Info info

basicURI

public URI basicURI

Constructor Details

PKIClient

public PKIClient(ClientConfig config)
          throws Exception

Throws:

Exception

PKIClient

public PKIClient(ClientConfig config,
 org.mozilla.jss.ssl.SSLCertificateApprovalCallback callback)
          throws Exception

Throws:

Exception

PKIClient

public PKIClient(ClientConfig config,
 String apiVersion,
 org.mozilla.jss.ssl.SSLCertificateApprovalCallback callback)
          throws Exception

Throws:

Exception

Method Details

getAPIVersion

public String getAPIVersion()

getDefaultMimeType

public String getDefaultMimeType()

getSubsystem

public String getSubsystem()

marshall

public String marshall(Object request)
                throws Exception

Marshall request object with custom mapping if available.

Throws:

Exception

unmarshall

public <T> T unmarshall(org.apache.http.HttpEntity entity,
 Class<T> clazz)
                 throws Exception

Unmarshall response object using custom mapping if available.

Throws:

Exception

unmarshallCollection

public <T> Collection<T> unmarshallCollection(org.apache.http.HttpEntity entity,
 Class<T> clazz)
                                       throws Exception

Throws:

Exception

handleErrorResponse

public void handleErrorResponse(org.apache.http.client.methods.CloseableHttpResponse httpResp)
                         throws Exception

Throws:

Exception

entity

public <T> org.apache.http.HttpEntity entity(T object)
                                      throws Exception

Throws:

Exception

getEntity

public <T> T getEntity(org.apache.http.client.methods.CloseableHttpResponse httpResp,
 Class<T> clazz)
                throws Exception

Throws:

Exception

getEntities

public <T> Collection<T> getEntities(org.apache.http.client.methods.CloseableHttpResponse httpResp,
 Class<T> clazz)
                              throws Exception

Throws:

Exception

getConfig

public ClientConfig getConfig()

getConnection

public PKIConnection getConnection()

target

public org.apache.http.client.utils.URIBuilder target(String path,
 Map<String,Object> params)

get

public <T> T get(String path,
 Class<T> responseType)
          throws Exception

Throws:

Exception

get

public <T> T get(String path,
 Map<String,Object> params,
 Class<T> responseType)
          throws Exception

Throws:

Exception

getCollection

public <T> Collection<T> getCollection(String path,
 Map<String,Object> params,
 Class<T> responseType)
                                throws Exception

Throws:

Exception

post

public <T> T post(String path,
 Class<T> responseType)
           throws Exception

Throws:

Exception

post

public <T> T post(String path,
 Map<String,Object> params,
 Class<T> responseType)
           throws Exception

Throws:

Exception

post

public <T> T post(String path,
 Map<String,Object> params,
 org.apache.http.HttpEntity entity,
 Class<T> responseType)
           throws Exception

Throws:

Exception

post

public <T> T post(String path,
 List<org.apache.http.NameValuePair> content,
 Class<T> responseType)
           throws Exception

Throws:

Exception

put

public <T> T put(String path,
 Map<String,Object> params,
 org.apache.http.HttpEntity entity,
 Class<T> responseType)
          throws Exception

Throws:

Exception

patch

public <T> T patch(String path,
 Map<String,Object> params,
 org.apache.http.HttpEntity entity,
 Class<T> responseType)
            throws Exception

Throws:

Exception

delete

public <T> T delete(String path,
 Class<T> responseType)
             throws Exception

Throws:

Exception

delete

public <T> T delete(String path,
 Map<String,Object> params,
 Class<T> responseType)
             throws Exception

Throws:

Exception

getInfo

public Info getInfo()
             throws Exception

Throws:

Exception

setOutput

public void setOutput(File output)

close

public void close()

Specified by:

close in interface AutoCloseable